WaitForMultipleItemValues(IEasyDAClient,IReadOnlyList<DAItemGroupArguments>,Int32) Method

Waits until the OPC-DA items reach the default minimum quality. Specify arguments objects, and timeout in milliseconds.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function WaitForMultipleItemValues( _
   ByVal client As IEasyDAClient, _
   ByVal itemGroupArgumentsList As IReadOnlyList(Of DAItemGroupArguments), _
   ByVal millisecondsTimeout As Integer _
) As ValueResult()

'Usage
 
Dim client As IEasyDAClient
Dim itemGroupArgumentsList As IReadOnlyList(Of DAItemGroupArguments)
Dim millisecondsTimeout As Integer
Dim value() As ValueResult
 
value = IEasyDAClientExtension2.WaitForMultipleItemValues(client, itemGroupArgumentsList, millisecondsTimeout)

[Extension()]
[NotNull()]
public static ValueResult[] WaitForMultipleItemValues( 
   IEasyDAClient client,
   IReadOnlyList<DAItemGroupArguments> itemGroupArgumentsList,
   int millisecondsTimeout
)

[Extension()]
[NotNull()]
public:
static array<ValueResult^>^ WaitForMultipleItemValues( 
   IEasyDAClient^ client,
   IReadOnlyList<DAItemGroupArguments^>^ itemGroupArgumentsList,
   int millisecondsTimeout
)

Parameters

client

The client object that will perform the operation.

This is typically the OpcLabs.EasyOpc.DataAccess.EasyDAClient object.

The value of this parameter cannot be null (Nothing in Visual Basic).

itemGroupArgumentsList

List of OPC-DA item group arguments (each argument holds an OPC server and item descriptor, and OPC group parameters).

The value of this parameter cannot be null (Nothing in Visual Basic).

The individual elements of the parameter value cannot be null (Nothing in Visual Basic).

millisecondsTimeout

The number of milliseconds to wait, or System.Threading.Timeout.Infinite to wait indefinitely.

Valid values of this parameter are in the range from -1 to 2147483647 (Int32.MaxValue).

Return Value

The function returns an array of OpcLabs.BaseLib.OperationModel.ValueResult objects. The indices of elements in the output array are the same as those in the input list, .

This method never returns null (Nothing in Visual Basic).

The individual elements of the returned value are never null (Nothing in Visual Basic).

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.ArgumentOutOfRangeException	The value of an argument is outside the allowable range of values as defined by the invoked method. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.ArgumentOutOfRangeException

The value of an argument is outside the allowable range of values as defined by the invoked method.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

IEasyDAClientExtension2 Class
IEasyDAClientExtension2 Members
Overload List

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.